Skip to content

docs(planning): adopt portable two-axis planning convention#21

Merged
lesnik512 merged 11 commits into
mainfrom
docs/portable-planning-convention
Jun 13, 2026
Merged

docs(planning): adopt portable two-axis planning convention#21
lesnik512 merged 11 commits into
mainfrom
docs/portable-planning-convention

Conversation

@lesnik512

Copy link
Copy Markdown
Member

Summary

Ports the portable two-axis planning convention from lite-bootstrap #120 (itself from faststream-outbox #77) into semvertag. Docs/file-moves only — no runtime code, tests, or public API touched (428 passed / 100% coverage).

  • New architecture/ truth home at the repo root — one file per capability (strategies.md, providers.md, cli.md), seeded from CLAUDE.md + the code. The promotion target on every future ship.
  • planning/changes/{active,archive}/<YYYY-MM-DD.NN-slug>/ bundles. All 15 existing planning/specs/ + planning/plans/ pairs migrated into archived bundles via git mv (history preserved) + YAML frontmatter (.NN from git first-commit order; pr: null with the PR ref carried in outcome:, matching lite-bootstrap's house style).
  • planning/README.md## Conventions block byte-identical to lite-bootstrap; fresh repo-specific Index.
  • planning/_templates/{design,plan,change}.md + planning/deferred.md copied byte-identical.
  • CLAUDE.md ## Workflow rewritten to the bundle convention (names architecture/ as the promotion target); the ## What the codebase ships provider count corrected to two (GitLab, GitHub).
  • Justfile gains docs-build (strict local mkdocs gate); .gitignore loses the bare plan.md rule (it would have swallowed every bundle's plan.md).
  • Release-notes spec/plan links repointed to the migrated bundle paths.
  • Dogfooded: this change is its own bundle (changes/active/2026-06-13.01-portable-planning-convention/), to be moved to archive/ on merge.

Test Plan

  • just lint-ci — clean (eof-fixer, ruff format/check, ty)
  • just test — 428 passed, 100% coverage
  • just docs-buildmkdocs build --strict exits 0 (architecture/ + planning/ are outside docs_dir)
  • Frontmatter parses on all 30 migrated bundle files; slug/date match folder; architecture/*.md carry no frontmatter
  • ## Conventions block + _templates/ + deferred.md byte-identical to lite-bootstrap
  • Live-surface stale-pointer sweep clean (frozen archived bundle bodies retain historical refs by design); README Index + release-note links resolve
  • git mv history preserved (--follow reaches original commits)

On merge

Move changes/active/2026-06-13.01-portable-planning-convention/archive/, fill status: shipped/pr:/outcome:, and shift its README Index line from Active to Archived. No architecture/ promotion — this change defines the convention, not a library capability.

🤖 Generated with Claude Code

lesnik512 and others added 11 commits June 13, 2026 20:28
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Pulls the .gitignore plan.md fix forward (Task 2) since the bare rule
would otherwise exclude this very plan.md from git.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…keleton

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ersion label

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@lesnik512 lesnik512 merged commit 558fad6 into main Jun 13, 2026
6 checks passed
@lesnik512 lesnik512 deleted the docs/portable-planning-convention branch June 13, 2026 18:23
lesnik512 added a commit that referenced this pull request Jun 13, 2026
…#22)

Promote the convention's own change bundle from active/ to archive/ with
status: shipped, pr: 21, outcome filled, per its on-merge note. Shift its
README Index line from Active to Archived.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant